Skip to main content

vpnRenewCheck

Description

check before renewal.

Request Method

GET

Request Path

/customer/vpn/renew/check

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
instanceIdQueryStringNoNo sample value for this parameter. instance id
regionIdQueryStringNoNo sample value for this parameter. region id
periodQueryStringNoNo sample value for this parameter. period
pricingCycleQueryStringNoNo sample value for this parameter. pricing cycle
couponInstanceIdQueryStringNoNo sample value for this parameter. coupon of the order
voucherInstanceIdQueryStringNoNo sample value for this parameter. voucher of the order

Return data

NameTypeSample valueDescription
sslConnectionintegerNo sample value for this parameter.when SSL-VPN is enable,it will show and need to choose
instanceIdstringNo sample value for this parameter.vpn instance id
regionIdstringNo sample value for this parameter.region id
gatewayNamestringNo sample value for this parameter.vpn name
vSwitchIdstringNo sample value for this parameter.vSwitch id
bandwidthintegerNo sample value for this parameter.bandwidth 5-100 (Mbps)
billingMethodstringNo sample value for this parameter.billing method
vpcIdstringNo sample value for this parameter.vpc id
sslVpnbooleanNo sample value for this parameter.enable SSL-VPN
ipSecVpnbooleanNo sample value for this parameter.enable IPsec-VPN
expirationDateintegerNo sample value for this parameter.expire time

Example

Successful Response example

{
"result":
{
"sslConnection":5.0,
"instanceId":"VPN-NRP339782378999668736",
"gatewayName":"TheCurrentVpnName",
"regionId":"cn-wulan-sta1-d01",
"vSwitchId":"vsw-nj3mrjkr96iwldig0vulr/zcw",
"vpcId":"vpc-nj3ptd8vtuyyoh08idhne/zcw",
"billingMethod":"Subscription",
"organization":"organization",
"sslVpn":true,
"capacity":1024.0,
"ipSecVpn":true,
"expirationDate":1.6615296E+12
},
"resultCode":"0",
"resultMsg":"success"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}